home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / librw / RWHashDictionaryIterator.z / RWHashDictionaryIterator
Encoding:
Text File  |  2002-10-03  |  5.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                  RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWHashDictionaryIterator - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               #include <rw/hashdict.h>
  13.  
  14.  
  15.  
  16.  
  17.           RWHashDictionary hd;
  18.           RWHashDictionaryIterator  iter(hd);
  19.  
  20.  
  21.  
  22.  
  23. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  24.      Iterator for class RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy, allowing sequential access to all
  25.      the elements of RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy.  Since RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy is unordered,
  26.      elements are not accessed in any particular order.  Like all Rogue Wave
  27.      iterators, the "current item" is undefined immediately after construction
  28.      -- you must define it by using ooooppppeeeerrrraaaattttoooorrrr(((()))) or some other (valid)
  29.      operation.  Once the iterator has advanced beyond the end of the
  30.      collection it is no longer valid -- continuing to use it will bring
  31.      undefined results.
  32.  
  33. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  34.      None
  35.  
  36. PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  37.               RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr(RWHashDictionary&);
  38.  
  39.  
  40.      Construct an iterator for an RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy collection.  Immediately
  41.      after construction, the position of the iterator is undefined until
  42.      positioned.
  43.  
  44. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrr
  45.               virtual RWCollectable*
  46.           ooooppppeeeerrrraaaattttoooorrrr(((())))();
  47.  
  48.  
  49.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Advances the iterator to the next key-
  50.      value pair and returns the key.  Returns nnnniiiillll if the cursor is at the end
  51.      of the collection.  Use member function vvvvaaaalllluuuueeee(((()))) to recover the value.
  52.  
  53. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  54.               virtual RWCollectable*
  55.           ffffiiiinnnnddddNNNNeeeexxxxtttt(const RWCollectable* target);
  56.  
  57.  
  58.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Moves the iterator to the next key-
  59.      value pair where the key iiiissssEEEEqqqquuuuaaaallll to the object pointed to by ttttaaaarrrrggggeeeetttt.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                  RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.      Returns the key or nnnniiiillll if no key was found.
  75.  
  76.               virtual RWCollectable*
  77.           kkkkeeeeyyyy() const;
  78.  
  79.  
  80.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Returns the key at the current iterator
  81.      position.
  82.  
  83.               RWCollectable*
  84.           rrrreeeemmmmoooovvvveeee();
  85.  
  86.  
  87.      Removes the key-value pair at the current iterator position.  Returns the
  88.      key, or nnnniiiillll if there was no key-value pair.
  89.  
  90.               RWCollectable*
  91.           rrrreeeemmmmoooovvvveeeeNNNNeeeexxxxtttt(const RWCollectable* target);
  92.  
  93.  
  94.      Moves the iterator to the next key-value pair where the key iiiissssEEEEqqqquuuuaaaallll to
  95.      the object pointed to by ttttaaaarrrrggggeeeetttt.  Removes the key-value pair, returning
  96.      the key or nnnniiiillll if there was no match.
  97.  
  98.               virtual void
  99.           rrrreeeesssseeeetttt();
  100.  
  101.  
  102.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Inherited from class RRRRWWWWSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr.
  103.      Resets the iterator to its initial state.
  104.  
  105.               RWCollectable*
  106.           vvvvaaaalllluuuueeee() const;
  107.  
  108.  
  109.      Returns the value at the current iterator position.
  110.  
  111.               RWCollectable*
  112.           vvvvaaaalllluuuueeee(RWCollectable* newValue) const;
  113.  
  114.  
  115.      Replaces the value at the current iterator position and returns the old
  116.      value.
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.